<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="contactcenterinsights_v1.html">Contact Center AI Insights API</a> . <a href="contactcenterinsights_v1.projects.html">projects</a> . <a href="contactcenterinsights_v1.projects.locations.html">locations</a> . <a href="contactcenterinsights_v1.projects.locations.phraseMatchers.html">phraseMatchers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a phrase matcher.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a phrase matcher.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a phrase matcher.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists phrase matchers.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a phrase matcher.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Creates a phrase matcher.

Args:
  parent: string, Required. The parent resource of the phrase matcher. Required. The location to create a phrase matcher for. Format: `projects//locations/` or `projects//locations/` (required)
  body: object, The request body.
    The object takes the form of:

{ # The phrase matcher resource.
  &quot;activationUpdateTime&quot;: &quot;A String&quot;, # Output only. The most recent time at which the activation status was updated.
  &quot;active&quot;: True or False, # Applies the phrase matcher only when it is active.
  &quot;displayName&quot;: &quot;A String&quot;, # The human-readable name of the phrase matcher.
  &quot;name&quot;: &quot;A String&quot;, # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
  &quot;phraseMatchRuleGroups&quot;: [ # A list of phase match rule groups that are included in this matcher.
    { # A message representing a rule in the phrase matcher.
      &quot;phraseMatchRules&quot;: [ # A list of phrase match rules that are included in this group.
        { # The data for a phrase match rule.
          &quot;config&quot;: { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule.
            &quot;exactMatchConfig&quot;: { # Exact match configuration. # The configuration for the exact match rule.
              &quot;caseSensitive&quot;: True or False, # Whether to consider case sensitivity when performing an exact match.
            },
          },
          &quot;negated&quot;: True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.
          &quot;query&quot;: &quot;A String&quot;, # Required. The phrase to be matched.
        },
      ],
      &quot;type&quot;: &quot;A String&quot;, # Required. The type of this phrase match rule group.
    },
  ],
  &quot;revisionCreateTime&quot;: &quot;A String&quot;, # Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.
  &quot;revisionId&quot;: &quot;A String&quot;, # Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567
  &quot;roleMatch&quot;: &quot;A String&quot;, # The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.
  &quot;type&quot;: &quot;A String&quot;, # Required. The type of this phrase matcher.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The most recent time at which the phrase matcher was updated.
  &quot;versionTag&quot;: &quot;A String&quot;, # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The phrase matcher resource.
  &quot;activationUpdateTime&quot;: &quot;A String&quot;, # Output only. The most recent time at which the activation status was updated.
  &quot;active&quot;: True or False, # Applies the phrase matcher only when it is active.
  &quot;displayName&quot;: &quot;A String&quot;, # The human-readable name of the phrase matcher.
  &quot;name&quot;: &quot;A String&quot;, # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
  &quot;phraseMatchRuleGroups&quot;: [ # A list of phase match rule groups that are included in this matcher.
    { # A message representing a rule in the phrase matcher.
      &quot;phraseMatchRules&quot;: [ # A list of phrase match rules that are included in this group.
        { # The data for a phrase match rule.
          &quot;config&quot;: { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule.
            &quot;exactMatchConfig&quot;: { # Exact match configuration. # The configuration for the exact match rule.
              &quot;caseSensitive&quot;: True or False, # Whether to consider case sensitivity when performing an exact match.
            },
          },
          &quot;negated&quot;: True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.
          &quot;query&quot;: &quot;A String&quot;, # Required. The phrase to be matched.
        },
      ],
      &quot;type&quot;: &quot;A String&quot;, # Required. The type of this phrase match rule group.
    },
  ],
  &quot;revisionCreateTime&quot;: &quot;A String&quot;, # Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.
  &quot;revisionId&quot;: &quot;A String&quot;, # Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567
  &quot;roleMatch&quot;: &quot;A String&quot;, # The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.
  &quot;type&quot;: &quot;A String&quot;, # Required. The type of this phrase matcher.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The most recent time at which the phrase matcher was updated.
  &quot;versionTag&quot;: &quot;A String&quot;, # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes a phrase matcher.

Args:
  name: string, Required. The name of the phrase matcher to delete. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets a phrase matcher.

Args:
  name: string, Required. The name of the phrase matcher to get. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The phrase matcher resource.
  &quot;activationUpdateTime&quot;: &quot;A String&quot;, # Output only. The most recent time at which the activation status was updated.
  &quot;active&quot;: True or False, # Applies the phrase matcher only when it is active.
  &quot;displayName&quot;: &quot;A String&quot;, # The human-readable name of the phrase matcher.
  &quot;name&quot;: &quot;A String&quot;, # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
  &quot;phraseMatchRuleGroups&quot;: [ # A list of phase match rule groups that are included in this matcher.
    { # A message representing a rule in the phrase matcher.
      &quot;phraseMatchRules&quot;: [ # A list of phrase match rules that are included in this group.
        { # The data for a phrase match rule.
          &quot;config&quot;: { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule.
            &quot;exactMatchConfig&quot;: { # Exact match configuration. # The configuration for the exact match rule.
              &quot;caseSensitive&quot;: True or False, # Whether to consider case sensitivity when performing an exact match.
            },
          },
          &quot;negated&quot;: True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.
          &quot;query&quot;: &quot;A String&quot;, # Required. The phrase to be matched.
        },
      ],
      &quot;type&quot;: &quot;A String&quot;, # Required. The type of this phrase match rule group.
    },
  ],
  &quot;revisionCreateTime&quot;: &quot;A String&quot;, # Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.
  &quot;revisionId&quot;: &quot;A String&quot;, # Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567
  &quot;roleMatch&quot;: &quot;A String&quot;, # The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.
  &quot;type&quot;: &quot;A String&quot;, # Required. The type of this phrase matcher.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The most recent time at which the phrase matcher was updated.
  &quot;versionTag&quot;: &quot;A String&quot;, # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists phrase matchers.

Args:
  parent: string, Required. The parent resource of the phrase matcher. (required)
  filter: string, A filter to reduce results to a specific subset. Useful for querying phrase matchers with specific properties.
  pageSize: integer, The maximum number of phrase matchers to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
  pageToken: string, The value returned by the last `ListPhraseMatchersResponse`. This value indicates that this is a continuation of a prior `ListPhraseMatchers` call and that the system should return the next page of data.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response of listing phrase matchers.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  &quot;phraseMatchers&quot;: [ # The phrase matchers that match the request.
    { # The phrase matcher resource.
      &quot;activationUpdateTime&quot;: &quot;A String&quot;, # Output only. The most recent time at which the activation status was updated.
      &quot;active&quot;: True or False, # Applies the phrase matcher only when it is active.
      &quot;displayName&quot;: &quot;A String&quot;, # The human-readable name of the phrase matcher.
      &quot;name&quot;: &quot;A String&quot;, # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
      &quot;phraseMatchRuleGroups&quot;: [ # A list of phase match rule groups that are included in this matcher.
        { # A message representing a rule in the phrase matcher.
          &quot;phraseMatchRules&quot;: [ # A list of phrase match rules that are included in this group.
            { # The data for a phrase match rule.
              &quot;config&quot;: { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule.
                &quot;exactMatchConfig&quot;: { # Exact match configuration. # The configuration for the exact match rule.
                  &quot;caseSensitive&quot;: True or False, # Whether to consider case sensitivity when performing an exact match.
                },
              },
              &quot;negated&quot;: True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.
              &quot;query&quot;: &quot;A String&quot;, # Required. The phrase to be matched.
            },
          ],
          &quot;type&quot;: &quot;A String&quot;, # Required. The type of this phrase match rule group.
        },
      ],
      &quot;revisionCreateTime&quot;: &quot;A String&quot;, # Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.
      &quot;revisionId&quot;: &quot;A String&quot;, # Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567
      &quot;roleMatch&quot;: &quot;A String&quot;, # The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.
      &quot;type&quot;: &quot;A String&quot;, # Required. The type of this phrase matcher.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The most recent time at which the phrase matcher was updated.
      &quot;versionTag&quot;: &quot;A String&quot;, # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates a phrase matcher.

Args:
  name: string, The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} (required)
  body: object, The request body.
    The object takes the form of:

{ # The phrase matcher resource.
  &quot;activationUpdateTime&quot;: &quot;A String&quot;, # Output only. The most recent time at which the activation status was updated.
  &quot;active&quot;: True or False, # Applies the phrase matcher only when it is active.
  &quot;displayName&quot;: &quot;A String&quot;, # The human-readable name of the phrase matcher.
  &quot;name&quot;: &quot;A String&quot;, # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
  &quot;phraseMatchRuleGroups&quot;: [ # A list of phase match rule groups that are included in this matcher.
    { # A message representing a rule in the phrase matcher.
      &quot;phraseMatchRules&quot;: [ # A list of phrase match rules that are included in this group.
        { # The data for a phrase match rule.
          &quot;config&quot;: { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule.
            &quot;exactMatchConfig&quot;: { # Exact match configuration. # The configuration for the exact match rule.
              &quot;caseSensitive&quot;: True or False, # Whether to consider case sensitivity when performing an exact match.
            },
          },
          &quot;negated&quot;: True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.
          &quot;query&quot;: &quot;A String&quot;, # Required. The phrase to be matched.
        },
      ],
      &quot;type&quot;: &quot;A String&quot;, # Required. The type of this phrase match rule group.
    },
  ],
  &quot;revisionCreateTime&quot;: &quot;A String&quot;, # Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.
  &quot;revisionId&quot;: &quot;A String&quot;, # Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567
  &quot;roleMatch&quot;: &quot;A String&quot;, # The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.
  &quot;type&quot;: &quot;A String&quot;, # Required. The type of this phrase matcher.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The most recent time at which the phrase matcher was updated.
  &quot;versionTag&quot;: &quot;A String&quot;, # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.
}

  updateMask: string, The list of fields to be updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The phrase matcher resource.
  &quot;activationUpdateTime&quot;: &quot;A String&quot;, # Output only. The most recent time at which the activation status was updated.
  &quot;active&quot;: True or False, # Applies the phrase matcher only when it is active.
  &quot;displayName&quot;: &quot;A String&quot;, # The human-readable name of the phrase matcher.
  &quot;name&quot;: &quot;A String&quot;, # The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
  &quot;phraseMatchRuleGroups&quot;: [ # A list of phase match rule groups that are included in this matcher.
    { # A message representing a rule in the phrase matcher.
      &quot;phraseMatchRules&quot;: [ # A list of phrase match rules that are included in this group.
        { # The data for a phrase match rule.
          &quot;config&quot;: { # Configuration information of a phrase match rule. # Provides additional information about the rule that specifies how to apply the rule.
            &quot;exactMatchConfig&quot;: { # Exact match configuration. # The configuration for the exact match rule.
              &quot;caseSensitive&quot;: True or False, # Whether to consider case sensitivity when performing an exact match.
            },
          },
          &quot;negated&quot;: True or False, # Specifies whether the phrase must be missing from the transcript segment or present in the transcript segment.
          &quot;query&quot;: &quot;A String&quot;, # Required. The phrase to be matched.
        },
      ],
      &quot;type&quot;: &quot;A String&quot;, # Required. The type of this phrase match rule group.
    },
  ],
  &quot;revisionCreateTime&quot;: &quot;A String&quot;, # Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.
  &quot;revisionId&quot;: &quot;A String&quot;, # Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567
  &quot;roleMatch&quot;: &quot;A String&quot;, # The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.
  &quot;type&quot;: &quot;A String&quot;, # Required. The type of this phrase matcher.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The most recent time at which the phrase matcher was updated.
  &quot;versionTag&quot;: &quot;A String&quot;, # The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`.
}</pre>
</div>

</body></html>